multiselection: Clarify docs
authorMatthias Clasen <mclasen@redhat.com>
Sat, 6 Jun 2020 14:22:37 +0000 (10:22 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Sat, 6 Jun 2020 14:24:14 +0000 (10:24 -0400)
Make it clear that GtkMultiSelection is not persistent
across resorting.

gtk/gtkmultiselection.c

index a97718e7047f415028a901a30cb608d23080e923..11caa78fc15840bd1961ebe0bb3ddef9c55650d8 100644 (file)
  *
  * GtkMultiSelection is an implementation of the #GtkSelectionModel interface
  * that allows selecting multiple elements.
+ *
+ * Note that due to the way the selection is stored, newly added items are
+ * always unselected, even if they were just removed from the model, and were
+ * selected before. In particular this means that changing the sort order of
+ * an underlying sort model will clear the selection. In other words, the
+ * selection is *not persistent*.
  */
 
 struct _GtkMultiSelection